Skip to content

docs: how-to/reference sweep — typed-config consistency, runnable how-tos, auth example#686

Merged
rickylabs merged 5 commits into
mainfrom
docs/660-howto-reference-sweep
Jul 11, 2026
Merged

docs: how-to/reference sweep — typed-config consistency, runnable how-tos, auth example#686
rickylabs merged 5 commits into
mainfrom
docs/660-howto-reference-sweep

Conversation

@rickylabs

Copy link
Copy Markdown
Owner

Closes #660 (slice B of 2 — merged after slice A; together they complete the issue's acceptance)

How-to/reference/pillar sweep per the merged docs-audit spec (proposals 7, 8, 9, 10, 11, 12, 15):

  • PORT/typed-config consistency sentence on the 8 flagged pages (source-verified against packages/config service schema; apps.<name>.port variant for the Fresh app page).
  • reference/ai/index.md: explicit provider-keys-have-no-typed-config note.
  • reference/queue|kv: "See it live" link blocks; reference/contracts|sdk: showcase ledes.
  • Runnable end-to-end blocks for discover-services, choose-a-queue-provider, add-a-task-runtime-adapter (grounded APIs only).
  • identity-access/better-auth-plugins.md: complete session-gated route-protection example at auth.md depth.
  • durable-workflows/streams.md: intentional-design reframe sentence.

Validation: docs verify green — 169 pages / 23,456 links; grep gate 0 hits on all 18 touched pages (worklog in-branch at .llm/runs/docs-660b-sweep--opus/).

Authored by a Claude Opus 4.8 docs agent under the beta-8 orchestrator (4d300496); Tier-A reviewed.

rickylabs and others added 5 commits July 12, 2026 00:33
Aspire injects PORT at runtime; netscript.config.ts services.<name>.port
(apps.<name>.port for Fresh apps) is the typed source of truth the scaffold
wires as the fallback default. One shared sentence at each first parseInt
occurrence so the raw-env read no longer reads as the canonical pattern.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VifzAytcxBk5odEMaCXihM
 #8 #9 #10 #15)

- reference/ai: explicit note that AI provider keys have no typed config
  surface; raw Deno.env.get is the supported path (#8).
- reference/queue + reference/kv: See-it-live link blocks to the queue-kv-cron
  how-to and data-persistence concept page (#9).
- reference/contracts + reference/sdk: showcase sentence per lede — contracts
  obviate manual req.json() validation; defineServices() wires the whole typed
  stack in one call (#10).
- durable-workflows/streams: one sentence reframing no in-process subscribe()
  as an intentional single HTTP/SSE surface (#15).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VifzAytcxBk5odEMaCXihM
)

discover-services, choose-a-queue-provider, and add-a-task-runtime-adapter
each gain one copy-pasteable end-to-end block (resulting file + full command
sequence) at deploy-local-aspire density, demonstrating the pluggability the
pages previously only asserted. All commands/APIs grounded in package source.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VifzAytcxBk5odEMaCXihM
 #12)

A real Fresh routes/*.tsx handler gated on an active session and an admin role,
at sibling auth.md's depth: resolves the session via backend.sessions.getSession,
maps to a Principal with principalMapper, and fails closed on both checks.
Grounded in packages/auth-better-auth + @netscript/service/auth exports.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VifzAytcxBk5odEMaCXihM
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VifzAytcxBk5odEMaCXihM
@rickylabs
rickylabs force-pushed the docs/660-howto-reference-sweep branch from e25279e to e3553e4 Compare July 11, 2026 22:34
@rickylabs
rickylabs marked this pull request as ready for review July 11, 2026 22:42
@rickylabs
rickylabs merged commit 27ded34 into main Jul 11, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs epic:docs-cut beta.7 docs release cut epic (tutorials + positioning) priority:p1 High status:ready-merge type:docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs(web-layer): frontend docs overhaul — showcase the typesafe meta-framework surface (contract routes, not unsafe URL params)

1 participant